<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class Zend_Loader</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> Zend_Loader</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Static methods for loading classes and files.</p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)</li>
				<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Loader.php.html">/Loader.php</a> (line <span class="field">30</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
											
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">string|false</span>
										<a href="#autoload" title="details" class="method-name">autoload</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">boolean</span>
										<a href="#isReadable" title="details" class="method-name">isReadable</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">void</span>
										<a href="#loadClass" title="details" class="method-name">loadClass</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span> = <span class="var-default">null</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">boolean</span>
										<a href="#loadFile" title="details" class="method-name">loadFile</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$once</span> = <span class="var-default">false</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">void</span>
										<a href="#registerAutoload" title="details" class="method-name">registerAutoload</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Zend_Loader'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$enabled</span> = <span class="var-default">true</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">boolean</span>
										<a href="#_includeFile" title="details" class="method-name">_includeFile</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$filespec</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$once</span> = <span class="var-default">false</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">void</span>
										<a href="#_securityCheck" title="details" class="method-name">_securityCheck</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
									</div>
																																																																							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodautoload" id="autoload"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static autoload</span> (line <span class="line-number">184</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">spl_autoload() suitable implementation for supporting class autoloading.</p>
<p class="description"><p>Attach to spl_autoload() using the following:  <div class="src-code"><ol><li><div class="src-line">&nbsp;<a href="http://www.php.net/spl_autoload_register">spl_autoload_register</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'Zend_Loader'</span><span class="src-sym">,&nbsp;</span><span class="src-str">'autoload'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Class name on success; false on failure</li>
				<li><span class="field">deprecated:</span> Since 1.8.0</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string|false</span>
		<span class="method-name">
			autoload
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisReadable" id="isReadable"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static isReadable</span> (line <span class="line-number">163</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns TRUE if the $filename is readable, or FALSE otherwise.</p>
<p class="description"><p>This function uses the PHP include_path, where PHP's is_readable()  does not.</p><p>Note from ZF-2900:  If you use custom error handler, please check whether return value   from error_reporting() is zero or not.  At mark of fopen() can not suppress warning if the handler is used.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">boolean</span>
		<span class="method-name">
			isReadable
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filename</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloadClass" id="loadClass"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static loadClass</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads a class from a PHP file.  The filename must be formatted  as &quot;$class.php&quot;.</p>
<p class="description"><p>If $dirs is a string or an array, it will search the directories  in the order supplied, and attempt to load the first matching file.</p><p>If $dirs is null, it will split the class name at underscores to  generate a path hierarchy (e.g., &quot;Zend_Example_Class&quot; will map  to &quot;Zend/Example/Class.php&quot;).</p><p>If the file was not found in the $dirs, or if no $dirs were specified,  it will attempt to load it from PHP's include_path.</p></p>
	<ul class="tags">
				<li><span class="field">throws:</span> Zend_Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			loadClass
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span><span class="var-description">: <ul><li>The full class name of a Zend component.</li></ul></span>			</li>
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$dirs</span><span class="var-description">: - OPTIONAL Either a path or an array of paths                              to search.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloadFile" id="loadFile"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static loadFile</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads a PHP file.  This is a wrapper for PHP's include() function.</p>
<p class="description"><p>$filename must be the complete filename, including any  extension such as &quot;.php&quot;.  Note that a security check is performed that  does not permit extended characters in the filename.  This method is  intended for loading Zend Framework files.</p><p>If $dirs is a string or an array, it will search the directories  in the order supplied, and attempt to load the first matching file.</p><p>If the file was not found in the $dirs, or if no $dirs were specified,  it will attempt to load it from PHP's include_path.</p><p>If $once is TRUE, it will use include_once() instead of include().</p></p>
	<ul class="tags">
				<li><span class="field">throws:</span> Zend_Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">boolean</span>
		<span class="method-name">
			loadFile
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string|array</span>&nbsp;<span class="var-name">$dirs</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$once</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filename</span>			</li>
					<li>
				<span class="var-type">string|array</span>
				<span class="var-name">$dirs</span><span class="var-description">: - OPTIONAL either a path or array of paths                        to search.</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$once</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregisterAutoload" id="registerAutoload"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static registerAutoload</span> (line <span class="line-number">205</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register autoload() with spl_autoload()</p>
	<ul class="tags">
				<li><span class="field">deprecated:</span> Since 1.8.0</li>
				<li><span class="field">throws:</span> Zend_Exception if spl_autoload() is not found  or if the specified class does not have an autoload() method.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			registerAutoload
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Zend_Loader'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$enabled</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span><span class="var-description">: (optional)</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$enabled</span><span class="var-description">: (optional)</span>			</li>
				</ul>
		
			
	</div>
<a name="method_includeFile" id="_includeFile"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static _includeFile</span> (line <span class="line-number">262</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Attempt to include() the file.</p>
<p class="description"><p>include() is not prefixed with the @ operator because if  the file is loaded and contains a parse error, execution  will halt silently and this is difficult to debug.</p><p>Always set display_errors = Off on production servers!</p></p>
	<ul class="tags">
				<li><span class="field">deprecated:</span> Since 1.5.0; use loadFile() instead</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">boolean</span>
		<span class="method-name">
			_includeFile
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$filespec</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$once</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filespec</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$once</span>			</li>
				</ul>
		
			
	</div>
<a name="method_securityCheck" id="_securityCheck"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static _securityCheck</span> (line <span class="line-number">237</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ensure that filename does not contain exploits</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Zend_Exception</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			_securityCheck
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filename</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Mon, 26 Oct 2009 10:08:51 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>